Add SMB and NFS Data Connector Docs by lukekim · Pull Request #1295 · spiceai/docs

lukekim · 2026-01-05T20:18:40Z

This pull request significantly improves the documentation for the FTP/SFTP Data Connector and the general data connector file format support. The changes focus on making configuration and usage clearer, adding practical examples, and updating terminology to reflect recent improvements. The documentation now provides a more user-friendly quickstart, detailed configuration instructions, and troubleshooting guidance. Additionally, the supported data connectors and file formats have been updated and clarified.

FTP/SFTP Data Connector Documentation Improvements:

Added a comprehensive quickstart section, including YAML and SQL usage examples, to help users get started quickly.
Clarified the differences between FTP and SFTP, including a comparison table and security recommendations.
Expanded configuration documentation with clearer descriptions, parameter tables, and multiple real-world examples (e.g., single file, directory, custom ports, timeouts, Hive partitioning, acceleration).
Added troubleshooting tips for common issues such as timeouts, authentication failures, and file format errors.

General Data Connector and File Format Documentation Updates:

Updated the list of supported data connectors to include SMB and NFS, and clarified their alpha status and supported formats.
Rewrote the file formats section to clarify when and how to specify file_format, provide status and descriptions of each supported format, and list format-specific parameters.
Added documentation for Hive-style partitioning, including configuration and query examples, and explained document format handling and schema.

These changes make the documentation more accessible, actionable, and up-to-date for users working with FTP/SFTP and other file-based data connectors.

github-actions · 2026-01-05T20:18:49Z

✅ Pull with Spice Passed

Passing checks:

✅ Title meets minimum length requirement (10 characters)
✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
✅ No banned labels detected
✅ Has at least one assignee: lukekim

github-actions · 2026-01-05T20:18:50Z

🔍 Pull with Spice Failed

Passing checks:

✅ Title meets minimum length requirement (10 characters)
✅ No banned labels detected
✅ Has at least one assignee: lukekim

Failed checks:

❌ Please select at least one of the required labels for this pull request: area/blog, area/docs, area/cookbook, dependencies

Please address these issues and update your pull request.

github-actions · 2026-01-05T20:18:50Z

🔍 Pull with Spice Failed

Passing checks:

✅ Title meets minimum length requirement (10 characters)
✅ No banned labels detected
✅ Has at least one assignee: lukekim

Failed checks:

❌ Please select at least one of the required labels for this pull request: area/blog, area/docs, area/cookbook, dependencies

Please address these issues and update your pull request.

github-actions · 2026-01-06T00:16:47Z

🚀 deployed to https://d243fad4.spiceai-org-website.pages.dev

* Remove OTel ports from docs (#1270) * Docs for Google (#1286) Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> * Parameterized Queries docs (#1298) * Paramterized Queries docs * Formatting * Add SMB and NFS Data Connector Docs (#1295) * Add SMB & NFS Data Connector docs * Fixes * formatting * Rename "params" key (#1300) * Fix params (#1301) * Update Dynamodb Authentication (#1304) * Update Dynamodb Auth * Update * Cayenne: document cayenne_file_path and cayenne_metadata_dir (#1307) * Update snapshots documentation (#1318) * Update snapshots documentation * Fix * Docs for snapshots_reset_expiry_on_load (#1322) * Minor fixes for DynamoDB (#1323) * Minor fixes for DynamoDB * Minor fix * Update Distributed Query docs for v1.11 changes (#1326) * Update Distributed Query docs for v1.11 changes * Update website/docs/features/distributed-query/index.md Co-authored-by: Jack Eadie <jack@spice.ai> --------- Co-authored-by: Jack Eadie <jack@spice.ai> * ScyllaDB Data Connector docs (#1325) * Add Arrow Hash Index docs (#1324) * Add Arrow Hash Index docs * Formatting * Add versioning support (#1308) * Add versioning support * Fix: empty versions array until release branches exist * Enable versioned docs for release/1.11 branch * Fix: resolve git refs with origin/ prefix for CI * Fix: run git archive from repo root * Fix: serve current docs at /docs, versioned docs at /docs/v1.11 * fix(versioning): only show unmaintained banner for versions outside maintenance window * Update to 1 * feat(versioning): add enterprise support note on unmaintained version banner * feat(versioning): add support for unreleased docs from trunk - Current docs (trunk) now served at /docs/next with 'unreleased' banner - Latest release branch served at /docs as the default - Previous versions continue at /docs/v1.11, etc. * Move to right * feat(versioning): auto-detect release branches from git - Script now auto-detects release/<major>.<minor> branches - No manual VERSIONS array maintenance required - Creating a new release branch automatically adds version to docs * Fix * fix(versioning): highest version is 'next', second highest is 'latest' - v1.11.x (highest) → Next (unreleased) at /docs/next - v1.10.x (second) → Latest (stable) at /docs - Trunk docs available at /docs/trunk - Previous versions at /docs/v1.9, etc. * fix(versioning): warn on broken links for cross-version compatibility Older release branches may contain absolute links to docs pages that don't exist in all versions. Setting onBrokenLinks to 'warn' allows the build to succeed while still reporting these issues. * Fixes * Fixes * Update menu * Improve SMB docs (#1328) * Improve copilot instructions * Improve SMB docs --------- Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Jack Eadie <jack@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com>

* v1.11 Documentation (#1296) * Remove OTel ports from docs (#1270) * Docs for Google (#1286) Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> * Parameterized Queries docs (#1298) * Paramterized Queries docs * Formatting * Add SMB and NFS Data Connector Docs (#1295) * Add SMB & NFS Data Connector docs * Fixes * formatting * Rename "params" key (#1300) * Fix params (#1301) * Update Dynamodb Authentication (#1304) * Update Dynamodb Auth * Update * Cayenne: document cayenne_file_path and cayenne_metadata_dir (#1307) * Update snapshots documentation (#1318) * Update snapshots documentation * Fix * Docs for snapshots_reset_expiry_on_load (#1322) * Minor fixes for DynamoDB (#1323) * Minor fixes for DynamoDB * Minor fix * Update Distributed Query docs for v1.11 changes (#1326) * Update Distributed Query docs for v1.11 changes * Update website/docs/features/distributed-query/index.md Co-authored-by: Jack Eadie <jack@spice.ai> --------- Co-authored-by: Jack Eadie <jack@spice.ai> * ScyllaDB Data Connector docs (#1325) * Add Arrow Hash Index docs (#1324) * Add Arrow Hash Index docs * Formatting * Add versioning support (#1308) * Add versioning support * Fix: empty versions array until release branches exist * Enable versioned docs for release/1.11 branch * Fix: resolve git refs with origin/ prefix for CI * Fix: run git archive from repo root * Fix: serve current docs at /docs, versioned docs at /docs/v1.11 * fix(versioning): only show unmaintained banner for versions outside maintenance window * Update to 1 * feat(versioning): add enterprise support note on unmaintained version banner * feat(versioning): add support for unreleased docs from trunk - Current docs (trunk) now served at /docs/next with 'unreleased' banner - Latest release branch served at /docs as the default - Previous versions continue at /docs/v1.11, etc. * Move to right * feat(versioning): auto-detect release branches from git - Script now auto-detects release/<major>.<minor> branches - No manual VERSIONS array maintenance required - Creating a new release branch automatically adds version to docs * Fix * fix(versioning): highest version is 'next', second highest is 'latest' - v1.11.x (highest) → Next (unreleased) at /docs/next - v1.10.x (second) → Latest (stable) at /docs - Trunk docs available at /docs/trunk - Previous versions at /docs/v1.9, etc. * fix(versioning): warn on broken links for cross-version compatibility Older release branches may contain absolute links to docs pages that don't exist in all versions. Setting onBrokenLinks to 'warn' allows the build to succeed while still reporting these issues. * Fixes * Fixes * Update menu * Improve SMB docs (#1328) * Improve copilot instructions * Improve SMB docs --------- Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Jack Eadie <jack@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com> * Update snapshot storage configuration description Clarified that the location for snapshots must be an S3 directory instead of a folder. --------- Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com>

* Remove OTel ports from docs (#1270) * Docs for Google (#1286) Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> * Parameterized Queries docs (#1298) * Paramterized Queries docs * Formatting * Add SMB and NFS Data Connector Docs (#1295) * Add SMB & NFS Data Connector docs * Fixes * formatting * Rename "params" key (#1300) * Fix params (#1301) * Update Dynamodb Authentication (#1304) * Update Dynamodb Auth * Update * Cayenne: document cayenne_file_path and cayenne_metadata_dir (#1307) * Update snapshots documentation (#1318) * Update snapshots documentation * Fix * Docs for snapshots_reset_expiry_on_load (#1322) * Minor fixes for DynamoDB (#1323) * Minor fixes for DynamoDB * Minor fix * Update Distributed Query docs for v1.11 changes (#1326) * Update Distributed Query docs for v1.11 changes * Update website/docs/features/distributed-query/index.md Co-authored-by: Jack Eadie <jack@spice.ai> --------- Co-authored-by: Jack Eadie <jack@spice.ai> * ScyllaDB Data Connector docs (#1325) * Add Arrow Hash Index docs (#1324) * Add Arrow Hash Index docs * Formatting * Add versioning support (#1308) * Add versioning support * Fix: empty versions array until release branches exist * Enable versioned docs for release/1.11 branch * Fix: resolve git refs with origin/ prefix for CI * Fix: run git archive from repo root * Fix: serve current docs at /docs, versioned docs at /docs/v1.11 * fix(versioning): only show unmaintained banner for versions outside maintenance window * Update to 1 * feat(versioning): add enterprise support note on unmaintained version banner * feat(versioning): add support for unreleased docs from trunk - Current docs (trunk) now served at /docs/next with 'unreleased' banner - Latest release branch served at /docs as the default - Previous versions continue at /docs/v1.11, etc. * Move to right * feat(versioning): auto-detect release branches from git - Script now auto-detects release/<major>.<minor> branches - No manual VERSIONS array maintenance required - Creating a new release branch automatically adds version to docs * Fix * fix(versioning): highest version is 'next', second highest is 'latest' - v1.11.x (highest) → Next (unreleased) at /docs/next - v1.10.x (second) → Latest (stable) at /docs - Trunk docs available at /docs/trunk - Previous versions at /docs/v1.9, etc. * fix(versioning): warn on broken links for cross-version compatibility Older release branches may contain absolute links to docs pages that don't exist in all versions. Setting onBrokenLinks to 'warn' allows the build to succeed while still reporting these issues. * Fixes * Fixes * Update menu * Improve SMB docs (#1328) * Improve copilot instructions * Improve SMB docs * Docs for snapshots_creation_policy (#1330) * Improvements (#1333) * Add High Availability documentation for distributed query clusters (#1334) * Update kafka/debezium docs * Update snapshot storage configuration description (#1331) * v1.11 Documentation (#1296) * Remove OTel ports from docs (#1270) * Docs for Google (#1286) Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> * Parameterized Queries docs (#1298) * Paramterized Queries docs * Formatting * Add SMB and NFS Data Connector Docs (#1295) * Add SMB & NFS Data Connector docs * Fixes * formatting * Rename "params" key (#1300) * Fix params (#1301) * Update Dynamodb Authentication (#1304) * Update Dynamodb Auth * Update * Cayenne: document cayenne_file_path and cayenne_metadata_dir (#1307) * Update snapshots documentation (#1318) * Update snapshots documentation * Fix * Docs for snapshots_reset_expiry_on_load (#1322) * Minor fixes for DynamoDB (#1323) * Minor fixes for DynamoDB * Minor fix * Update Distributed Query docs for v1.11 changes (#1326) * Update Distributed Query docs for v1.11 changes * Update website/docs/features/distributed-query/index.md Co-authored-by: Jack Eadie <jack@spice.ai> --------- Co-authored-by: Jack Eadie <jack@spice.ai> * ScyllaDB Data Connector docs (#1325) * Add Arrow Hash Index docs (#1324) * Add Arrow Hash Index docs * Formatting * Add versioning support (#1308) * Add versioning support * Fix: empty versions array until release branches exist * Enable versioned docs for release/1.11 branch * Fix: resolve git refs with origin/ prefix for CI * Fix: run git archive from repo root * Fix: serve current docs at /docs, versioned docs at /docs/v1.11 * fix(versioning): only show unmaintained banner for versions outside maintenance window * Update to 1 * feat(versioning): add enterprise support note on unmaintained version banner * feat(versioning): add support for unreleased docs from trunk - Current docs (trunk) now served at /docs/next with 'unreleased' banner - Latest release branch served at /docs as the default - Previous versions continue at /docs/v1.11, etc. * Move to right * feat(versioning): auto-detect release branches from git - Script now auto-detects release/<major>.<minor> branches - No manual VERSIONS array maintenance required - Creating a new release branch automatically adds version to docs * Fix * fix(versioning): highest version is 'next', second highest is 'latest' - v1.11.x (highest) → Next (unreleased) at /docs/next - v1.10.x (second) → Latest (stable) at /docs - Trunk docs available at /docs/trunk - Previous versions at /docs/v1.9, etc. * fix(versioning): warn on broken links for cross-version compatibility Older release branches may contain absolute links to docs pages that don't exist in all versions. Setting onBrokenLinks to 'warn' allows the build to succeed while still reporting these issues. * Fixes * Fixes * Update menu * Improve SMB docs (#1328) * Improve copilot instructions * Improve SMB docs --------- Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Jack Eadie <jack@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com> * Update snapshot storage configuration description Clarified that the location for snapshots must be an S3 directory instead of a folder. --------- Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com> Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com> * Update Snowflake data connector docs (#1340) * fix: convert absolute /docs/ links to relative paths * Update Cayenne accelerator status from Alpha to Beta (#1341) * URL tables docs (#1343) * URL tables docs * Formatting * Improve snapshots documentation + retention (#1342) * Improve snapshots documnetation + retention * Fix --------- Co-authored-by: Jack Eadie <jack@spice.ai> * Fix links * Formatting * Update version references in documentation and scripts for v2.1 release * Handle major versions * Fix merge conflicts --------- Co-authored-by: Phillip LeBlanc <phillip@spice.ai> Co-authored-by: Jack Eadie <jack@spice.ai> Co-authored-by: Evgenii Khramkov <evgenii@spice.ai> Co-authored-by: Viktor Yershov <viktor@spice.ai> Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com>

Add SMB & NFS Data Connector docs

fb8c79b

lukekim added this to the v1.11 milestone Jan 5, 2026

lukekim self-assigned this Jan 5, 2026

lukekim added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 5, 2026

github-actions Bot added area/docs release labels Jan 5, 2026

lukekim added 2 commits January 5, 2026 12:18

Merge branch 'release/1.11' into lukim/smb-nfs

1f15a19

Merge branch 'release/1.11' into lukim/smb-nfs

f526983

lukekim added area/docs and removed area/docs labels Jan 5, 2026

Merge branch 'release/1.11' into lukim/smb-nfs

e4f83ee

lukekim added area/docs and removed area/docs labels Jan 5, 2026

Merge branch 'release/1.11' into lukim/smb-nfs

3d498ef

peasee approved these changes Jan 5, 2026

View reviewed changes

Comment thread website/docs/components/data-connectors/index.md

Comment thread website/docs/components/data-connectors/smb.md

lukekim added 2 commits January 5, 2026 16:14

Fixes

6e875a0

formatting

9ae131b

github-actions Bot deployed to preview January 6, 2026 00:16 View deployment

lukekim merged commit 9fb6526 into release/1.11 Jan 6, 2026
3 checks passed

lukekim deleted the lukim/smb-nfs branch January 6, 2026 00:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SMB and NFS Data Connector Docs#1295

Add SMB and NFS Data Connector Docs#1295
lukekim merged 7 commits into
release/1.11from
lukim/smb-nfs

lukekim commented Jan 5, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 5, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

github-actions Bot commented Jan 5, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jan 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

lukekim commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull with Spice Passed

Passing checks:

Uh oh!

github-actions Bot commented Jan 5, 2026

🔍 Pull with Spice Failed

Passing checks:

Failed checks:

Uh oh!

github-actions Bot commented Jan 5, 2026

🔍 Pull with Spice Failed

Passing checks:

Failed checks:

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jan 6, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lukekim commented Jan 5, 2026 •

edited

Loading

github-actions Bot commented Jan 5, 2026 •

edited

Loading